IAxis.SetPositionOffset method

Shifts the coordinate system of an axis by manipulating both the setpoint position as well as the actual position of an axis with the same value without any movement caused (recalibration with same following error). This can be used for instance for a reference situation.

Namespace: IntervalZero.KINGSTAR.Base.Class

Assembly: IntervalZero.KINGSTAR.Base.Class (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB

void SetPositionOffset(
       double position,
       bool relative
)

Sub SetPositionOffset(
       position As Double,
       relative As Boolean
)

Parameters

position

Type: double

Position unit (it's the distance unit if relative is true).

relative

Type: bool

true if it's relative distance; false if it's absolute position. By default, it is false.

Remarks

This method can only be used in the Standstill or Disabled state.
Relative means that Position (distance unit) is added to the actual position of the axis at the time of execution. The resulting target position will be the actual position + distance. For example, the actual position is 50. Distance is 100. The target position will be 150. "Absolute" means that the actual position of the axis is the value specified in the Position parameter.